home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / include / engrave / engrave_enums.h < prev    next >
Encoding:
C/C++ Source or Header  |  2006-01-09  |  3.4 KB  |  113 lines
  1. #ifndef ENGRAVE_ENUMS_H
  2. #define ENGRAVE_ENUMS_H
  3.  
  4. /**
  5.  * @file engrave_enums.h
  6.  * @brief Contains all of the enumerations used in Engrave
  7.  */
  8.  
  9. /**
  10.  * @defgroup Engrave_Enums Enums: Various Flags and Enumerations used in Engrave.
  11.  * @{
  12.  */
  13.  
  14. typedef enum _Engrave_Image_Type Engrave_Image_Type;
  15. typedef enum _Engrave_Part_Type Engrave_Part_Type;
  16. typedef enum _Engrave_Text_Effect Engrave_Text_Effect;
  17. typedef enum _Engrave_Action Engrave_Action;
  18. typedef enum _Engrave_Transition Engrave_Transition;
  19. typedef enum _Engrave_Aspect_Preference Engrave_Aspect_Preference;
  20. typedef enum _Engrave_Parse_Section Engrave_Parse_Section;
  21.  
  22. /**
  23.  * @enum Engrave_Image_Type
  24.  * This defines the various types of image compression available.
  25.  */
  26. enum _Engrave_Image_Type
  27. {
  28.   ENGRAVE_IMAGE_TYPE_RAW, /**< No compression, no loss of detail */
  29.   ENGRAVE_IMAGE_TYPE_COMP, /**< Compress image, no loss of detail */
  30.   ENGRAVE_IMAGE_TYPE_LOSSY, /**< Lossy compression of image */
  31.   ENGRAVE_IMAGE_TYPE_NUM
  32. };
  33.  
  34. /**
  35.  * @enum Engrave_Part_Type
  36.  * This defines the different part types available.
  37.  */
  38. enum _Engrave_Part_Type
  39. {
  40.   ENGRAVE_PART_TYPE_IMAGE, /**< Part is an image */
  41.   ENGRAVE_PART_TYPE_TEXT, /**< Part is text */
  42.   ENGRAVE_PART_TYPE_RECT, /**< Part is a rectangle */
  43.   ENGRAVE_PART_TYPE_SWALLOW, /**< Part is a swallow */
  44.   ENGRAVE_PART_TYPE_NUM
  45. };
  46.  
  47. /**
  48.  * @enum Engrave_Text_Effect
  49.  * This defines the different types of effects that can be applied to a
  50.  * chunk of text.
  51.  */
  52. enum _Engrave_Text_Effect
  53. {
  54.   ENGRAVE_TEXT_EFFECT_NONE, /**< No text effect */
  55.   ENGRAVE_TEXT_EFFECT_PLAIN, /**< Normal text */
  56.   ENGRAVE_TEXT_EFFECT_OUTLINE, /**< Outlined text */
  57.   ENGRAVE_TEXT_EFFECT_SOFT_OUTLINE, /**< Soft outlined text */
  58.   ENGRAVE_TEXT_EFFECT_SHADOW, /**< Shadowed text */
  59.   ENGRAVE_TEXT_EFFECT_OUTLINE_SHADOW, /**< Outlined and shadowed text */
  60.   ENGRAVE_TEXT_EFFECT_SOFT_SHADOW, /**< Soft shadowed text */
  61.   ENGRAVE_TEXT_EFFECT_OUTLINE_SOFT_SHADOW, /**< Outlined and soft shadowed text */
  62.   ENGRAVE_TEXT_EFFECT_NUM
  63. };
  64.  
  65. /**
  66.  * @enum Engrave_Action
  67.  * The different types of actions that can be performed in a program.
  68.  */
  69. enum _Engrave_Action
  70. {
  71.   ENGRAVE_ACTION_STATE_SET, /**< Set the state of a given part */
  72.   ENGRAVE_ACTION_STOP, /**< Stop the given action */
  73.   ENGRAVE_ACTION_SIGNAL_EMIT, /**< Emit the given signal */
  74.   ENGRAVE_ACTION_DRAG_VAL_SET, /**< Set the drag value of a given part */
  75.   ENGRAVE_ACTION_DRAG_VAL_STEP, /**< Set the drag step of a given part */
  76.   ENGRAVE_ACTION_DRAG_VAL_PAGE, /**< Set the drag page of a given part */
  77.   ENGRAVE_ACTION_SCRIPT, /**< Set implictly if a script {} block is included */
  78.   ENGRAVE_ACTION_NUM
  79. };
  80.  
  81. /**
  82.  * @enum Engrave_Transition
  83.  * The different types of transitions available to a program 
  84.  */
  85. enum _Engrave_Transition
  86. {
  87.   ENGRAVE_TRANSITION_LINEAR, /**< A linear transtion */
  88.   ENGRAVE_TRANSITION_SINUSOIDAL, /**< A sinusoidal transition */
  89.   ENGRAVE_TRANSITION_ACCELERATE, /**< An accelerating transition */
  90.   ENGRAVE_TRANSITION_DECELERATE, /**< A decelerating transition */
  91.   ENGRAVE_TRANSITION_NUM
  92. };
  93.  
  94. /**
  95.  * @enum Engrave_Aspect_Preference
  96.  * The differenty aspect preferences available 
  97.  */
  98. enum _Engrave_Aspect_Preference
  99. {
  100.   ENGRAVE_ASPECT_PREFERENCE_NONE, /**< No aspect preference */
  101.   ENGRAVE_ASPECT_PREFERENCE_VERTICAL, /**< Vertical aspect preference */
  102.   ENGRAVE_ASPECT_PREFERENCE_HORIZONTAL, /**< Horizontal aspect preference */
  103.   ENGRAVE_ASPECT_PREFERENCE_BOTH, /**< Vertical and Horizontal aspect preference */
  104.   ENGRAVE_ASPECT_PREFERENCE_NUM
  105. };
  106.  
  107. /**
  108.  * @}
  109.  */
  110.  
  111. #endif
  112.  
  113.